Gets a customer.
Gets the information of a customer with given number.
PATH:
/v1/clients/{clientId}/customers/{customerNumber}
PATH PARAMETERS:
clientId required
|
integer
The ID of the client. |
customerNumber required
|
string
The ID of the customer. |
RESPONSES:
RESPONSE SCHEMA:
array of _links
no description in swagger file |
|||||||||||||
Array () [
] |
|||||||||||||
customerNumber |
string
The ID of the customer. |
||||||||||||
type |
string Enum: Person Company Undefined
no description in swagger file |
||||||||||||
person object
Legal information of the person. |
|||||||||||||
|
|||||||||||||
company object
The organization info of the company. |
|||||||||||||
|
|||||||||||||
phoneNumber |
string
Optional. The phone number of the person/company. |
||||||||||||
string
Optional. The email address of the person/company. |
|||||||||||||
paymentMeans object
The ID list of payment methods (e.g. card). |
|||||||||||||
|
|||||||||||||
address object
The address of the customer. |
|||||||||||||
|
RESPONSE SCHEMA:
type |
string
The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type. |
title |
string
A short, human-readable summary of the problem. |
details |
string
A human-readable explanation specific to this occurrence of the problem. |
category |
string Enum: BusinessError TechnicalError
no description in swagger file |
RESPONSE SCHEMA:
type |
string
The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type. |
title |
string
A short, human-readable summary of the problem. |
details |
string
A human-readable explanation specific to this occurrence of the problem. |
category |
string Enum: BusinessError TechnicalError
no description in swagger file |
RESPONSE SCHEMA:
type |
string
The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type. |
title |
string
A short, human-readable summary of the problem. |
details |
string
A human-readable explanation specific to this occurrence of the problem. |
category |
string Enum: BusinessError TechnicalError
no description in swagger file |
Path
/v1/clients/{clientId}/customers/{customerNumber}
Response samples
200401403404- {
- "_links": [ ... ],
- "customerNumber": "string",
- "type": "string",
- "person": { ... },
- "company": { ... },
- "phoneNumber": "string",
- "email": "string",
- "paymentMeans": { ... },
- "address": { ... }
- {
- "type": "string",
- "title": "string",
- "details": "string",
- "category": "string"
- {
- "type": "string",
- "title": "string",
- "details": "string",
- "category": "string"
- {
- "type": "string",
- "title": "string",
- "details": "string",
- "category": "string"